<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dfeequ: xdfeequ.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dfeequ
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xdfeequ_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xdfeequ.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Contains the APIs for the DFE Equalizer Filter component. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.0   dc     09/03/20 Initial version
      dc     02/02/21 Remove hard coded device node name
      dc     02/22/21 align driver to current specification
      dc     03/15/21 Add data latency api
      dc     04/06/21 Register with full node name
      dc     04/07/21 Fix bare metal initialisation
      dc     04/20/21 Doxygen documentation update
      dc     05/08/21 Update to common trigger
1.1   dc     05/26/21 Update CFG_SHIFT calculation
      dc     07/13/21 Update to common latency requirements
      dc     10/26/21 Make driver R5 compatible
1.2   dc     10/29/21 Update doxygen comments
      dc     11/09/21 Add GetStateId API
      dc     11/19/21 Update doxygen documentation
      dc     12/17/21 Update after documentation review
1.3   dc     01/19/22 Assert Update trigger
      dc     01/24/22 Auto-compute number of units
      dc     02/18/22 Write 1 clears event status
      dc     03/21/22 Add prefix to global variables
1.4   dc     04/06/22 Update documentation
1.5   cog    07/04/23 Add support for SDT
1.6   cog    01/29/24 Yocto SDT support</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga17ee416036c9dbea48b203ba2cf8f00f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga17ee416036c9dbea48b203ba2cf8f00f">XDFEEQU_TAP_MAX</a>&#160;&#160;&#160;(24U)</td></tr>
<tr class="memdesc:ga17ee416036c9dbea48b203ba2cf8f00f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum tap value.  <a href="group__dfeequ.html#ga17ee416036c9dbea48b203ba2cf8f00f">More...</a><br/></td></tr>
<tr class="separator:ga17ee416036c9dbea48b203ba2cf8f00f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7660f2beb6a13a91282b6e2319701616"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga7660f2beb6a13a91282b6e2319701616">XDFEEQU_DRIVER_VERSION_MINOR</a>&#160;&#160;&#160;(6U)</td></tr>
<tr class="memdesc:ga7660f2beb6a13a91282b6e2319701616"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver's minor version number.  <a href="group__dfeequ.html#ga7660f2beb6a13a91282b6e2319701616">More...</a><br/></td></tr>
<tr class="separator:ga7660f2beb6a13a91282b6e2319701616"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac4d18ecc912ace6457c7fbe891e0cbd7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#gac4d18ecc912ace6457c7fbe891e0cbd7">XDFEEQU_DRIVER_VERSION_MAJOR</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:gac4d18ecc912ace6457c7fbe891e0cbd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Driver's major version number.  <a href="group__dfeequ.html#gac4d18ecc912ace6457c7fbe891e0cbd7">More...</a><br/></td></tr>
<tr class="separator:gac4d18ecc912ace6457c7fbe891e0cbd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga57eeb135c4ee22d243462e43795fcd45"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga57eeb135c4ee22d243462e43795fcd45">XDfeEqu_InstanceInit</a> (const char *DeviceNodeName)</td></tr>
<tr class="memdesc:ga57eeb135c4ee22d243462e43795fcd45"><td class="mdescLeft">&#160;</td><td class="mdescRight">API initialises one instance of an Equalizer driver.  <a href="group__dfeequ.html#ga57eeb135c4ee22d243462e43795fcd45">More...</a><br/></td></tr>
<tr class="separator:ga57eeb135c4ee22d243462e43795fcd45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga197062db05b1c51bc800b6a90e82838a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga197062db05b1c51bc800b6a90e82838a">XDfeEqu_InstanceClose</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga197062db05b1c51bc800b6a90e82838a"><td class="mdescLeft">&#160;</td><td class="mdescRight">API closes the instance of an Equalizer driver and moves the state machine to a Not Ready state.  <a href="group__dfeequ.html#ga197062db05b1c51bc800b6a90e82838a">More...</a><br/></td></tr>
<tr class="separator:ga197062db05b1c51bc800b6a90e82838a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14d48b6aa1a784e94ac55d1a8950c2bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga14d48b6aa1a784e94ac55d1a8950c2bf">XDfeEqu_Reset</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga14d48b6aa1a784e94ac55d1a8950c2bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets Equalizer and puts block into a reset state.  <a href="group__dfeequ.html#ga14d48b6aa1a784e94ac55d1a8950c2bf">More...</a><br/></td></tr>
<tr class="separator:ga14d48b6aa1a784e94ac55d1a8950c2bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8517b5d3c53f9694d03a3fe0868b3937"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga8517b5d3c53f9694d03a3fe0868b3937">XDfeEqu_Configure</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, <a class="el" href="struct_x_dfe_equ___cfg.html">XDfeEqu_Cfg</a> *Cfg)</td></tr>
<tr class="memdesc:ga8517b5d3c53f9694d03a3fe0868b3937"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads configuration from device tree/xparameters.h and IP registers.  <a href="group__dfeequ.html#ga8517b5d3c53f9694d03a3fe0868b3937">More...</a><br/></td></tr>
<tr class="separator:ga8517b5d3c53f9694d03a3fe0868b3937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga84403d8f6f2f4e9a45668d9dc7dc5b28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga84403d8f6f2f4e9a45668d9dc7dc5b28">XDfeEqu_Initialize</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, const <a class="el" href="struct_x_dfe_equ___eq_config.html">XDfeEqu_EqConfig</a> *Config)</td></tr>
<tr class="memdesc:ga84403d8f6f2f4e9a45668d9dc7dc5b28"><td class="mdescLeft">&#160;</td><td class="mdescRight">DFE Equalizer driver one time initialisation and moves the state machine to a Initialised state.  <a href="group__dfeequ.html#ga84403d8f6f2f4e9a45668d9dc7dc5b28">More...</a><br/></td></tr>
<tr class="separator:ga84403d8f6f2f4e9a45668d9dc7dc5b28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3eedb65f956253285490a558a751862"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#gac3eedb65f956253285490a558a751862">XDfeEqu_Activate</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, bool EnableLowPower)</td></tr>
<tr class="memdesc:gac3eedb65f956253285490a558a751862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activates channel Equalizer moves the state machine to an Activated state.  <a href="group__dfeequ.html#gac3eedb65f956253285490a558a751862">More...</a><br/></td></tr>
<tr class="separator:gac3eedb65f956253285490a558a751862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace488d54e41f3d8d9179f9be9bbbef58"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#gace488d54e41f3d8d9179f9be9bbbef58">XDfeEqu_Deactivate</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr)</td></tr>
<tr class="memdesc:gace488d54e41f3d8d9179f9be9bbbef58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivates Equalizer and moves the state machine to Initialised state.  <a href="group__dfeequ.html#gace488d54e41f3d8d9179f9be9bbbef58">More...</a><br/></td></tr>
<tr class="separator:gace488d54e41f3d8d9179f9be9bbbef58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7343bc5dbb0c15974f3c15184955ad89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dfeequ.html#ga023ff98141bd1c5721ba461a697a109f">XDfeEqu_StateId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga7343bc5dbb0c15974f3c15184955ad89">XDfeEqu_GetStateID</a> (<a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7343bc5dbb0c15974f3c15184955ad89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a state machine state id.  <a href="group__dfeequ.html#ga7343bc5dbb0c15974f3c15184955ad89">More...</a><br/></td></tr>
<tr class="separator:ga7343bc5dbb0c15974f3c15184955ad89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga493536b08c0b66462836a39423895aae"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga493536b08c0b66462836a39423895aae">XDfeEqu_Update</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, const <a class="el" href="struct_x_dfe_equ___eq_config.html">XDfeEqu_EqConfig</a> *Config)</td></tr>
<tr class="memdesc:ga493536b08c0b66462836a39423895aae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates Equalizer mode.  <a href="group__dfeequ.html#ga493536b08c0b66462836a39423895aae">More...</a><br/></td></tr>
<tr class="separator:ga493536b08c0b66462836a39423895aae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6007e4c4495f0ce8cd9c4ec9ec2a94a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga6007e4c4495f0ce8cd9c4ec9ec2a94a4">XDfeEqu_GetTriggersCfg</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, <a class="el" href="struct_x_dfe_equ___trigger_cfg.html">XDfeEqu_TriggerCfg</a> *TriggerCfg)</td></tr>
<tr class="memdesc:ga6007e4c4495f0ce8cd9c4ec9ec2a94a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current trigger configuration.  <a href="group__dfeequ.html#ga6007e4c4495f0ce8cd9c4ec9ec2a94a4">More...</a><br/></td></tr>
<tr class="separator:ga6007e4c4495f0ce8cd9c4ec9ec2a94a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8397193c8752e178b30f4161ebf24617"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga8397193c8752e178b30f4161ebf24617">XDfeEqu_SetTriggersCfg</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, <a class="el" href="struct_x_dfe_equ___trigger_cfg.html">XDfeEqu_TriggerCfg</a> *TriggerCfg)</td></tr>
<tr class="memdesc:ga8397193c8752e178b30f4161ebf24617"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trigger configuration.  <a href="group__dfeequ.html#ga8397193c8752e178b30f4161ebf24617">More...</a><br/></td></tr>
<tr class="separator:ga8397193c8752e178b30f4161ebf24617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab553aa1cfced879709804331bda8c876"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#gab553aa1cfced879709804331bda8c876">XDfeEqu_LoadCoefficients</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, u32 ChannelField, u32 Mode, u32 Shift, const <a class="el" href="struct_x_dfe_equ___coefficients.html">XDfeEqu_Coefficients</a> *EqCoeffs)</td></tr>
<tr class="memdesc:gab553aa1cfced879709804331bda8c876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets Equalizer filter coefficients in Real, Complex or Matrix mode.  <a href="group__dfeequ.html#gab553aa1cfced879709804331bda8c876">More...</a><br/></td></tr>
<tr class="separator:gab553aa1cfced879709804331bda8c876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0223057a4cb6242c44ddf078d49bb509"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga0223057a4cb6242c44ddf078d49bb509">XDfeEqu_GetActiveSets</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, u32 *RealSet, u32 *ImagSet)</td></tr>
<tr class="memdesc:ga0223057a4cb6242c44ddf078d49bb509"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets used coefficients settings.  <a href="group__dfeequ.html#ga0223057a4cb6242c44ddf078d49bb509">More...</a><br/></td></tr>
<tr class="separator:ga0223057a4cb6242c44ddf078d49bb509"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4996ddd3d1b3e4a372ece433df9a5766"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga4996ddd3d1b3e4a372ece433df9a5766">XDfeEqu_SetTUserDelay</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, u32 Delay)</td></tr>
<tr class="memdesc:ga4996ddd3d1b3e4a372ece433df9a5766"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the delay, which will be added to TUSER and TLAST (delay matched through the IP).  <a href="group__dfeequ.html#ga4996ddd3d1b3e4a372ece433df9a5766">More...</a><br/></td></tr>
<tr class="separator:ga4996ddd3d1b3e4a372ece433df9a5766"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5bf51f632644d52094760f6560d399dc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga5bf51f632644d52094760f6560d399dc">XDfeEqu_GetTUserDelay</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga5bf51f632644d52094760f6560d399dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the delay, which will be added to TUSER and TLAST (delay matched through the IP).  <a href="group__dfeequ.html#ga5bf51f632644d52094760f6560d399dc">More...</a><br/></td></tr>
<tr class="separator:ga5bf51f632644d52094760f6560d399dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec6fe6a5dad5653305058c1f3b72111a"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#gaec6fe6a5dad5653305058c1f3b72111a">XDfeEqu_GetTDataDelay</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, u32 Tap)</td></tr>
<tr class="memdesc:gaec6fe6a5dad5653305058c1f3b72111a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns data latency + tap, where the tap is between 0 and 23 in real mode and between 0 and 11 in complex mode.  <a href="group__dfeequ.html#gaec6fe6a5dad5653305058c1f3b72111a">More...</a><br/></td></tr>
<tr class="separator:gaec6fe6a5dad5653305058c1f3b72111a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga91f5801fc102819ea32fe8f0a40c43cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeequ.html#ga91f5801fc102819ea32fe8f0a40c43cb">XDfeEqu_GetVersions</a> (const <a class="el" href="struct_x_dfe_equ.html">XDfeEqu</a> *InstancePtr, <a class="el" href="struct_x_dfe_equ___version.html">XDfeEqu_Version</a> *SwVersion, <a class="el" href="struct_x_dfe_equ___version.html">XDfeEqu_Version</a> *HwVersion)</td></tr>
<tr class="memdesc:ga91f5801fc102819ea32fe8f0a40c43cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API gets the driver and HW design version.  <a href="group__dfeequ.html#ga91f5801fc102819ea32fe8f0a40c43cb">More...</a><br/></td></tr>
<tr class="separator:ga91f5801fc102819ea32fe8f0a40c43cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
